org.springframework.test.context

Class ContextCache

java.lang.Object

org.springframework.test.context.ContextCache

class ContextCache
extends java.lang.Object

Cache for Spring ApplicationContexts in a test environment.

Maintains a cache of ApplicationContexts keyed by MergedContextConfiguration instances.

This has significant performance benefits if initializing the context would take time. While initializing a Spring context itself is very quick, some beans in a context, such as a LocalSessionFactoryBean for working with Hibernate, may take some time to initialize. Hence it often makes sense to perform that initialization only once per test suite.

Since:

2.5

Author:

Sam Brannen, Juergen Hoeller

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<MergedContextConfiguration,ApplicationContext>	contextMap Map of context keys to Spring ApplicationContext instances.
private java.util.Map<MergedContextConfiguration,java.util.Set<MergedContextConfiguration>>	hierarchyMap Map of parent keys to sets of children keys, representing a top-down tree of context hierarchies.
private int	hitCount
private int	missCount
private java.lang.Object	monitor

Constructor Summary

Constructors

Constructor and Description
ContextCache()

Method Summary

Modifier and Type	Method and Description
(package private) void	clear() Clears all contexts from the cache and clears context hierarchy information as well.
(package private) void	clearStatistics() Clears hit and miss count statistics for the cache (i.e., resets counters to zero).
(package private) boolean	contains(MergedContextConfiguration key) Return whether there is a cached context for the given key.
(package private) ApplicationContext	get(MergedContextConfiguration key) Obtain a cached ApplicationContext for the given key.
(package private) int	getHitCount() Get the overall hit count for this cache.
(package private) int	getMissCount() Get the overall miss count for this cache.
(package private) int	getParentContextCount() Determine the number of parent contexts currently tracked within the cache.
private void	incrementHitCount() Increment the hit count by one.
private void	incrementMissCount() Increment the miss count by one.
(package private) void	put(MergedContextConfiguration key, ApplicationContext context) Explicitly add an ApplicationContext instance to the cache under the given key.
private void	remove(java.util.List<MergedContextConfiguration> removedContexts, MergedContextConfiguration key)
(package private) void	remove(MergedContextConfiguration key, DirtiesContext.HierarchyMode hierarchyMode) Remove the context with the given key from the cache and explicitly close it if it is an instance of ConfigurableApplicationContext.
(package private) int	size() Determine the number of contexts currently stored in the cache.
java.lang.String	toString() Generates a text string, which contains the size as well as the hit, miss, and parent context counts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

monitor

private final java.lang.Object monitor

contextMap

private final java.util.Map<MergedContextConfiguration,ApplicationContext> contextMap

Map of context keys to Spring ApplicationContext instances.

hierarchyMap

private final java.util.Map<MergedContextConfiguration,java.util.Set<MergedContextConfiguration>> hierarchyMap

Map of parent keys to sets of children keys, representing a top-down tree of context hierarchies. This information is used for determining which subtrees need to be recursively removed and closed when removing a context that is a parent of other contexts.

hitCount

private int hitCount

missCount

private int missCount

Constructor Detail

ContextCache

ContextCache()

Method Detail

clear

void clear()

Clears all contexts from the cache and clears context hierarchy information as well.

clearStatistics

void clearStatistics()

Clears hit and miss count statistics for the cache (i.e., resets counters to zero).

contains

boolean contains(MergedContextConfiguration key)

Return whether there is a cached context for the given key.

Parameters:

key - the context key (never null)

get

ApplicationContext get(MergedContextConfiguration key)

Obtain a cached ApplicationContext for the given key.

The hit and miss counts will be updated accordingly.

Parameters:

key - the context key (never null)

Returns:

the corresponding ApplicationContext instance, or null if not found in the cache.

See Also:

remove(org.springframework.test.context.MergedContextConfiguration, org.springframework.test.annotation.DirtiesContext.HierarchyMode)

incrementHitCount

private void incrementHitCount()

Increment the hit count by one. A hit is an access to the cache, which returned a non-null context for a queried key.

incrementMissCount

private void incrementMissCount()

Increment the miss count by one. A miss is an access to the cache, which returned a null context for a queried key.

getHitCount

int getHitCount()

Get the overall hit count for this cache. A hit is an access to the cache, which returned a non-null context for a queried key.

getMissCount

int getMissCount()

Get the overall miss count for this cache. A miss is an access to the cache, which returned a null context for a queried key.

put

void put(MergedContextConfiguration key,
         ApplicationContext context)

Explicitly add an ApplicationContext instance to the cache under the given key.

Parameters:

key - the context key (never null)

context - the ApplicationContext instance (never null)

remove

void remove(MergedContextConfiguration key,
            DirtiesContext.HierarchyMode hierarchyMode)

Remove the context with the given key from the cache and explicitly close it if it is an instance of ConfigurableApplicationContext.

Generally speaking, you would only call this method if you change the state of a singleton bean, potentially affecting future interaction with the context.

In addition, the semantics of the supplied HierarchyMode will be honored. See the Javadoc for DirtiesContext.HierarchyMode for details.

Parameters:

key - the context key; never null

hierarchyMode - the hierarchy mode; may be null if the context is not part of a hierarchy

remove

private void remove(java.util.List<MergedContextConfiguration> removedContexts,
                    MergedContextConfiguration key)

size

int size()

Determine the number of contexts currently stored in the cache. If the cache contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

getParentContextCount

int getParentContextCount()

Determine the number of parent contexts currently tracked within the cache.

toString

public java.lang.String toString()

Generates a text string, which contains the size as well as the hit, miss, and parent context counts.

Overrides:

toString in class java.lang.Object